Source generator samples #511

chsienki · 2020-04-15T03:14:41Z

Adds a sample generator project which contains three example generators:

HelloWorldGenerator.cs : a very simple example of injecting code into a users compilation
XmlSettingsGenerator.cs: an example of using additional files to create classes
AutoNotifyGenerator.cs: a more involved sample that implements automatic INotifyPropertyChanged support, and shows how to use the SyntaxReceiver functionality.

These are still a work in progress, and we expect them to change as we evolve the feature. In the long run these are expected to represent both simple how-to's and best practices with generators (we'll probably update the SG cookbook in the roslyn repo to start pointing here for example).

The project doesn't have tests yet. I suspect we'll want to build out some tooling like we provide for analyzers for testing generators.

jmarolf · 2020-04-15T17:40:41Z

@chsienki I suggest we keep this in its own branch until the feature is complete. Then we merge this into master once its done. We can also work on the testing portion of this in that branch

chsienki · 2020-04-15T17:59:38Z

@jmarolf Happy either way, I was originally going to leave it in a branch, but @jaredpar preferred it be in master, so we can easily point people to them (in @cartermp's blog post for instance)

jmarolf · 2020-04-15T18:36:25Z

@chsienki this link appears to work today. Would like to understand why that is not sufficient for @cartermp

jaredpar · 2020-04-16T03:34:14Z

I would prefer they be in master. This makes them more discoverable and hopefully in turns encourages customers to interact with them.

This is a samples section and these are samples of our work in progress. The compiler changes are in master even though they're not complete. Feels odd if the supporting samples weren't. If we want to make it clearer that they're not RTM we can make a nice README to discuss that.

jmarolf · 2020-04-16T04:22:08Z

I would be fine with a readme explaining that these are a work-in-progress. I am just concerned that we would have a bunch of shipped samples next to some in-progress ones with no differentiation

chsienki · 2020-04-23T00:21:07Z

Added a readme to explain they're in progress. Happy to play with the wording to get something we all like.

cartermp · 2020-04-24T22:56:18Z

How do I build these samples? install.ps1 just errors out:

cartermp · 2020-04-24T22:59:04Z

samples/CSharp/SourceGenerators/SourceGeneratorSamples/SourceGeneratorSamples.csproj

+
+  <ItemGroup>
+    <!--<PackageReference Include="Microsoft.CodeAnalysis.Analyzers" Version="2.9.8" />-->
+    <PackageReference Include="Microsoft.CodeAnalysis.CSharp.Workspaces" Version="3.6.0-3.20207.2" PrivateAssets="all" />


This currently emits a NuGet warning about depending on Microsoft.CodeAnalysis.Analyzers, picking 3.0.0-beta2.final.

chsienki · 2020-04-24T23:14:43Z

The install.ps1 are for installing the analyzers as a package, but we don't support it for generators yet. Removed to clear up confusion.

cartermp · 2020-04-24T23:20:17Z

samples/CSharp/SourceGenerators/SourceGeneratorSamples/HelloWorldGenerator.cs

+            // begin creating the source we'll inject into the users compilation
+            StringBuilder sourceBuilder = new StringBuilder(@"
+using System;
+namespace HelloWorldGenerator


Might be better to have this be HelloWorldGenerated to distinguish from the name of the generator

cartermp · 2020-04-24T23:21:37Z

In the README there should be instructions on how to install the sample generators into your own project. Since there's no example here showing consumption, folks will definitely want the prescriptive guidance.

- Add demo consumption project - Update readme - Lock samples to correct .net version via global.json

chsienki · 2020-04-25T00:32:23Z

@cartermp I Added a demo project that consumes the samples, and allows a 'one click' run experience to see what they do, and how to consume them.

I updated the readme to include how to build and consume in your own project.

I added a solution in the SourceGenerators dir so you can just open the generators sample + demo project without anything else.

cartermp · 2020-04-27T18:03:44Z

samples/CSharp/SourceGenerators/README.md

+
+Building the samples
+-----
+Open `SourceGenerators.sln` in Visual Studio or run `dotnet build` from the `\SourceGenerators` directory.


I don't see SourceGenerators.sln in this PR or repo. Did you mean to open Samples.sln?

Yes, it might help if I added that file to the repo huh?

cartermp · 2020-04-27T18:05:47Z

Samples.sln

+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "SourceGenerators", "SourceGenerators", "{14D18F51-6B59-49D5-9AB7-08B38417A459}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "SourceGeneratorSamples", "samples\CSharp\SourceGenerators\SourceGeneratorSamples\SourceGeneratorSamples.csproj", "{2ADE5CFA-5DF4-44A9-BD67-E884BCFBA045}"
+EndProject


This appears to be missing the consumption project.

cartermp

I think this one looks good enough to use and link to from the blog post. @jaredpar @jmarolf can you take another look?

jaredpar · 2020-04-28T21:16:10Z

Why did you need to downgrade the demo? This is now using a non-supported netcoreapp3.0 version. Is this a problem with the SDK repo? If so we can tackle in a later PR.

chsienki · 2020-04-28T21:19:54Z

Yeah, it wasn't able to build netcoreapp3.1

Looks like that just pushed the problem further though, because it's now using a compiler that doesn't support SourceGenerators.

I think I'll just remove them from the main 'shipping' samples.sln and keep the 'special' SourceGenerators.sln for now. We won't get CI, but we can fix that up in another PR?

jmarolf · 2020-04-28T21:22:28Z

@chsienki what was the original failure about? Do we need to install a runtime for .NET 3.1 or update the sdk in the global.json file?

chsienki · 2020-04-28T21:24:58Z

@jmarolf https://dev.azure.com/dnceng/public/_build/results?buildId=619533&view=logs&j=a846d25a-e32c-5640-1b53-e815fab94407&t=aafa82ad-f831-5b30-c619-9b12d27e8ee8

I think we'll need to update the global.json. I added one for the SourceGenerators.sln but its using a beta version of the sdk right now.

Wasn't sure if we'd want the shipping samples in the repo depening on a pre-release SDK?

jmarolf · 2020-04-28T21:27:14Z

ah change the global.json from this

{
  "tools": {
    "dotnet": "3.0.101",
    "vs": {
      "version": "16.3"
    },
    "xcopy-msbuild": "16.3.0-alpha"
  },
  "msbuild-sdks": {
    "Microsoft.DotNet.Arcade.Sdk": "5.0.0-beta.20117.3"
  }
}

to this

{
  "tools": {
    "dotnet": "3.1.101",
    "vs": {
      "version": "16.3"
    },
    "xcopy-msbuild": "16.3.0-alpha"
  },
  "msbuild-sdks": {
    "Microsoft.DotNet.Arcade.Sdk": "5.0.0-beta.20117.3"
  }
}

chsienki · 2020-04-28T21:37:52Z

That won't fix it though, because 3.1.101 doesn't include the source generator support.

So we need to either make the whole repo depend on 3.1.300 or remove them from the main samples solution.

jmarolf · 2020-04-28T21:54:53Z

ah, ok. I am fine with that, There are lots of repos that depend on un-released versions of the SDK

Remove special source generators one

fix reference in release

jaredpar · 2020-04-29T16:06:09Z

🎉

chsienki added 2 commits April 10, 2020 09:24

Add initial source generator samples

f3a533f

Add hello world generator, and clean up samples

e7b4ef5

chsienki requested a review from a team as a code owner April 15, 2020 03:14

Add WIP Readme

0e8d3eb

cartermp reviewed Apr 24, 2020

View reviewed changes

Clean up project + remove warning

09053bb

cartermp reviewed Apr 24, 2020

View reviewed changes

Expand samples:

6ebd7b7

- Add demo consumption project - Update readme - Lock samples to correct .net version via global.json

Whitespace

61d81ab

cartermp reviewed Apr 27, 2020

View reviewed changes

chsienki added 2 commits April 27, 2020 11:17

Add SourceGenerators.sln

8c4859a

Add generated project to main samples SLN

c41a496

cartermp approved these changes Apr 27, 2020

View reviewed changes

jmarolf approved these changes Apr 28, 2020

View reviewed changes

Downgrade generated demo to netcoreapp3.0

c034ef8

chsienki added 3 commits April 28, 2020 14:59

Update global.json

af2f5c2

Remove special source generators one

Bump arcade version too

b15fee6

Restore netcoreapp3.1

5985a80

fix reference in release

chsienki merged commit a560eb2 into master Apr 28, 2020

sharwell deleted the source-generator-samples branch May 1, 2020 17:22

jmarolf mentioned this pull request Sep 17, 2021

merging main into dev17.0 jmarolf/roslyn-sdk#1

Closed

jmarolf mentioned this pull request Oct 12, 2021

update versions jmarolf/roslyn-sdk#2

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Source generator samples #511

Source generator samples #511

chsienki commented Apr 15, 2020

jmarolf commented Apr 15, 2020

chsienki commented Apr 15, 2020

jmarolf commented Apr 15, 2020

jaredpar commented Apr 16, 2020

jmarolf commented Apr 16, 2020

chsienki commented Apr 23, 2020

cartermp commented Apr 24, 2020

cartermp Apr 24, 2020

chsienki Apr 24, 2020

chsienki commented Apr 24, 2020

cartermp Apr 24, 2020

chsienki Apr 25, 2020

cartermp commented Apr 24, 2020

chsienki commented Apr 25, 2020 •

edited

Loading

cartermp Apr 27, 2020

chsienki Apr 27, 2020

cartermp Apr 27, 2020

cartermp left a comment

jaredpar commented Apr 28, 2020

chsienki commented Apr 28, 2020

jmarolf commented Apr 28, 2020 •

edited

Loading

chsienki commented Apr 28, 2020 •

edited

Loading

jmarolf commented Apr 28, 2020

chsienki commented Apr 28, 2020

jmarolf commented Apr 28, 2020

jaredpar commented Apr 29, 2020

Source generator samples #511

Source generator samples #511

Conversation

chsienki commented Apr 15, 2020

jmarolf commented Apr 15, 2020

chsienki commented Apr 15, 2020

jmarolf commented Apr 15, 2020

jaredpar commented Apr 16, 2020

jmarolf commented Apr 16, 2020

chsienki commented Apr 23, 2020

cartermp commented Apr 24, 2020

cartermp Apr 24, 2020

Choose a reason for hiding this comment

chsienki Apr 24, 2020

Choose a reason for hiding this comment

chsienki commented Apr 24, 2020

cartermp Apr 24, 2020

Choose a reason for hiding this comment

chsienki Apr 25, 2020

Choose a reason for hiding this comment

cartermp commented Apr 24, 2020

chsienki commented Apr 25, 2020 • edited Loading

cartermp Apr 27, 2020

Choose a reason for hiding this comment

chsienki Apr 27, 2020

Choose a reason for hiding this comment

cartermp Apr 27, 2020

Choose a reason for hiding this comment

cartermp left a comment

Choose a reason for hiding this comment

jaredpar commented Apr 28, 2020

chsienki commented Apr 28, 2020

jmarolf commented Apr 28, 2020 • edited Loading

chsienki commented Apr 28, 2020 • edited Loading

jmarolf commented Apr 28, 2020

chsienki commented Apr 28, 2020

jmarolf commented Apr 28, 2020

jaredpar commented Apr 29, 2020

chsienki commented Apr 25, 2020 •

edited

Loading

jmarolf commented Apr 28, 2020 •

edited

Loading

chsienki commented Apr 28, 2020 •

edited

Loading